Buy

GitHub SSH

Description

Here you will learn how to use your TKey for SSH operations towards GitHub together with our app tkey-ssh-agent.

Installation and usage

Linux

Adding your public SSH key to your GitHub account

Note: Before proceeding, you must install tkey-ssh-agent on your device and generate a public SSH key, as described here.

  1. Follow the instructions on GitHub about how to connect to GitHub with SSH.
  2. Follow the instructions on GitHub about how to manage commit signature verification.

Testing your TKey for GitHub operations

  1. Enter a git command in your terminal that requires your permission. For example cloning a private repository. The status indicator on your TKey flashes green when a confirmation is needed.
    git clone git@github.com:<username>/<repository>.git
  2. Touch the touch sensor on your TKey to confirm the operation.

If you run into trouble with the SSH connection, use the troubleshooting guide.

macOS

Adding your public SSH key to your GitHub account

Note: Before proceeding, you must install tkey-ssh-agent on your device and generate a public SSH key, as described here.

  1. Follow the instructions on GitHub about how to connect to GitHub with SSH.
  2. Follow the instructions on GitHub about how to manage commit signature verification.

Testing your TKey for GitHub operations

  1. Enter a git command in your terminal that requires your permission. For example cloning a private repository. The status indicator on your TKey flashes green when a confirmation is needed.
    git clone git@github.com:<username>/<repository>.git
  2. Touch the touch sensor on your TKey to confirm the operation.

If you run into trouble with the SSH connection, use the troubleshooting guide.

Windows

Adding your public SSH key to your GitHub account

Note: Before proceeding, you must install tkey-ssh-agent on your device and generate a public SSH key, as described here.

  1. Follow the instructions on GitHub about how to connect to GitHub with SSH.
  2. Follow the instructions on GitHub about how to manage commit signature verification.

Testing your TKey for GitHub operations

  1. Enter a git command in your terminal that requires your permission. For example cloning a private repository. The status indicator on your TKey flashes green when a confirmation is needed.
    git clone git@github.com:<username>/<repository>.git
  2. Touch the touch sensor on your TKey to confirm the operation.

If you run into trouble with the SSH connection, use the troubleshooting guide.